fix(lsp): prevent negative deltaStart overflow in multi-line semantic token encoding#2095
Open
flohessling wants to merge 1 commit intohashicorp:mainfrom
Open
Conversation
|
Thank you for your submission! We require that all contributors sign our Contributor License Agreement ("CLA") before we can accept the contribution. Read and sign the agreement Learn more about why HashiCorp requires a CLA and what the CLA includes Have you signed the CLA already but the status is still pending? Recheck it. |
3 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes: #2094
Multi-line semantic tokens (e.g., heredoc strings with interpolations) produce negative
deltaStartvalues that wrap to largeuint32numbers. This causes LSP clients like Neovim to hang with 100% CPU usage.Root Cause
After a multi-line token is per-line split in
encodeTokenOfIndex(),te.lastEncodedTokenIdxstill points to the original token. The next token'spreviousStartCharis computed from the original token'sRange.Start.Column(high value from the first line of the heredoc), not from the last emitted line. When the next token starts at a lower column, the subtraction produces a negative value that wraps onuint32cast.Fix
Adds
lastEncodedLineandlastEncodedStartCharfields toTokenEncoderto track the actual last emitted position instead of deriving it from the original multi-line token's range.Testing
Adds
TestTokenEncoder_multiLineTokenFollowedBySameEndLineTokenwhich reproduces the exact scenario: a multi-line string token followed by a reference token on the same line as the string'sEnd.Line, with a lower column than the string'sStart.Column.PCI review checklist
Examples of changes to security controls include using new access control methods, adding or removing logging pipelines, etc.